/*
 * Copyright 2013 Nicholas Bilyk
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package jasper.model.elements;

/**
 * @author nbilyk
 */
public enum AttributeUse {

	/**
	 * Attribute is optional and may have any value. This is the default.
	 */
	OPTIONAL("optional"),

	/**
	 * Attribute cannot be used. This attribute is used in a restriction of another complex type to prohibit the
	 * use of existing attributes.
	 */
	PROHIBITED("prohibited"),

	/**
	 * Attribute must appear once.
	 * The attribute is required and can contain any value allowed by this type definition of the attribute.
	 * &lt;xs:attribute name="myattr" type="xs:string" use="required"/>
	 * This attribute is used in a restriction or extension of another complex type, to require that a specified
	 * attribute or attributes are present.
	 *
	 * If the attribute is declared as global (its parent element is schema), this attribute is required on all
	 * elements in the schema.
	 */
	REQUIRED("required");

	public String name;

	private AttributeUse(String name) {
		this.name = name;
	}
}
